feat(dc): Add executeQuery and executeMutation APIs to Data Connect #2979

stephenarosaj · 2025-09-17T22:36:03Z

API Changes

Added executeQuery() and executeMutation() to src/data-connect/data-connect.ts. These allow users to call deployed operations with impersonated auth credentials.

Testing

New unit tests added which match the coverage of existing executeGraphql* APIs
New integration tests added which more than match the coverage of existing executeGraphql* APIs
The tests pass locally, but a re-deploy of dataconnect to the CI/CD firebase project is required. Tagging @lahirumaramba

stephenarosaj · 2025-09-17T22:55:54Z

Note:

The integration tests have a huge diff because I moved the existing tests under a new parent describe(), and so their indentation level was increased. Existing tests were not changed in this PR.

stephenarosaj · 2025-09-18T20:46:47Z

Forgot a few changes! Didn't know that you could close and re-open :P thanks Yuchen!

stephenarosaj · 2025-09-24T22:51:12Z

wait - need to privatize the execute API, execution should come from operation refs (in a future PR)

src/data-connect/data-connect-api-client-internal.ts

maneesht · 2025-09-26T17:27:35Z

test/integration/dataconnect/dataconnect/my-connector/mutations.gql

 	user_upsert(data: { id: "fred_id", address: "32 Elm St.", name: "Fred" })
 }
-mutation updateFredrickUserImpersonation @auth(level: USER) {
+mutation updateFredrickUserImpersonation @auth(level: USER, insecureReason: "test") {


Note: These changes likely require a re-deploy on the CI project

Yes, they deff do - I'll leave this comment open to make sure it gets re-deployed! Tagging @lahirumaramba

test/unit/data-connect/data-connect-api-client-internal.spec.ts

… functions

…s, bypassing auth policies

…ions, bypassing auth policies

…rationRef.execute() API

maneesht · 2025-10-14T20:13:20Z

etc/firebase-admin.data-connect.api.md

+}
+
+// @public
+export function validateAdminArgs<Variables extends object>(connectorConfig: ConnectorConfig, dcOrVarsOrOptions?: DataConnect | Variables | OperationOptions, varsOrOptions?: Variables | OperationOptions, options?: OperationOptions, hasVars?: boolean, validateVars?: boolean): {


@lahirumaramba Any opinions on this? We only need this for the generated SDK, and we don't intend for developers to use this.

Good point, is there a way to not export this from the public API surface?

src/data-connect/data-connect-api-client-internal.ts

src/data-connect/validate-admin-args.ts

test/integration/data-connect.spec.ts

src/data-connect/validate-admin-args.ts

…nts, revert package changes

maneesht · 2025-10-15T22:36:40Z

test/unit/data-connect/validate-admin-args.spec.ts

+    getDataConnectStub = sinon.stub(DataConnectService.prototype, 'getDataConnect').returns(stubDcInstance);
+
+    // initializing app required, "using" it is required for successful build/compile 
+    app = initializeApp();


You might be able to get away with just calling initializeApp without setting the app to something

Was able to remove the initializeApp call entirely. Done.

maneesht · 2025-10-15T22:59:07Z

test/unit/data-connect/validate-admin-args.spec.ts

+    });
+
+    it('should successfully parse the provided options', () => {
+      const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateAdminArgs<object>(


Any reason why the object is needed?

maneesht · 2025-10-15T23:05:56Z

test/unit/data-connect/validate-admin-args.spec.ts

+            connectorConfig, variables, undefined, undefined, true, false
+          );
+          expect(dcInstance).to.deep.equal(stubDcInstance);
+          expect(inputVars).to.deep.equal(inputVars);


Typo?

Suggested change

expect(inputVars).to.deep.equal(inputVars);

expect(inputVars).to.deep.equal(variables);

maneesht · 2025-10-15T23:11:29Z

test/unit/index.spec.ts

 // Data Connect
 import './data-connect/index.spec';
 import './data-connect/data-connect-api-client-internal.spec';
+// import './data-connect/validate-admin-args.spec';


Remove comment

We should uncomment this if we want to run the tests in validate-admin-args.spec.ts

lahirumaramba · 2025-10-16T20:55:44Z

package.json

 {
  "name": "firebase-admin",
-  "version": "13.5.0",
+  "version": "13.4.0",


You can revert this. We update the package.json only during a release PR (which we will handle separately from this PR)

lahirumaramba · 2025-10-16T21:03:11Z

src/data-connect/data-connect.ts

+  public executeQuery<Data>(
+    name: string,
+    options?: OperationOptions
+  ): Promise<ExecuteOperationResponse<Data>>;


Does this handle the method overload correctly? If I call executeQuery('myQuery', { impersonate: ... }) would it take options as variables?

If that breaks the method overload we need to perform a runtime check to differentiate them.

public executeQuery<Data, Variables>( name: string, variablesOrOptions?: Variables | OperationOptions, options?: OperationOptions ): Promise<ExecuteOperationResponse<Data>> {

lahirumaramba · 2025-10-16T21:08:38Z

src/data-connect/data-connect.ts

+  public executeQuery<Data>(
+    name: string,
+    options?: OperationOptions
+  ): Promise<ExecuteOperationResponse<Data>>;


If that breaks the method overload we need to perform a runtime check to differentiate them.

public executeQuery<Data, Variables>( name: string, variablesOrOptions?: Variables | OperationOptions, options?: OperationOptions ): Promise<ExecuteOperationResponse<Data>> {

lahirumaramba · 2025-10-16T21:14:29Z

src/data-connect/index.ts

  DataConnect,
 } from './data-connect'
+export {
+  validateAdminArgs


If this function is only for internal usage let's not export it to the public API surface here

lahirumaramba · 2025-10-16T21:17:51Z

src/data-connect/data-connect-api.ts

- * Interface representing GraphQL options.
+ * Interface representing ExecuteOperation response.
+ */
+export interface ExecuteOperationResponse<GraphqlResponse> {


Is this interface identical to ExecuteGraphqlResponse? If that is the case and if we don't see it changing in the future, it might be better to create a type alias.

export type ExecuteOperationResponse<T> = ExecuteGraphqlResponse<T>;

stephenarosaj added 2 commits September 17, 2025 14:59

add in changes from stephenarosaj/fdc-impersonate

524d7d8

finish adding in changes from stephenarosaj/fdc-impersonate

bc92c5e

stephenarosaj requested a review from maneesht September 17, 2025 22:36

stephenarosaj added 2 commits September 17, 2025 15:41

update Google Inc. to Google LLC, run npm install; npm run build

d43588e

run npm apidocs

dcd493f

stephenarosaj marked this pull request as ready for review September 17, 2025 22:47

stephenarosaj closed this Sep 18, 2025

stephenarosaj reopened this Sep 18, 2025

stephenarosaj closed this Sep 18, 2025

stephenarosaj reopened this Sep 19, 2025

stephenarosaj closed this Sep 24, 2025

stephenarosaj added 2 commits September 24, 2025 15:53

remove public execute apis

23fe1f4

convert executeOperation api to OperationRef(...).execute() api

ae8096a

stephenarosaj reopened this Sep 25, 2025

stephenarosaj added the release:stage Stage a release candidate label Sep 25, 2025

stephenarosaj added 3 commits September 25, 2025 15:24

remove internal client from operation refs

52a18d7

cleanup javadocs to address workflow failures

3cb6645

npm run apidocs

bad9808

maneesht reviewed Sep 26, 2025

View reviewed changes

stephenarosaj added 8 commits September 26, 2025 11:14

spread GraphqlOptions arguments in OperationRefs and executeOperation…

6bdef60

… functions

convert unit tests to use spread args

798c2dc

convert integration tests to use spread args

85a6b4b

add executeQuery test cases which do not provide impersonation option…

5f34343

…s, bypassing auth policies

add executeMutation test cases which do not provide impersonation opt…

088d882

…ions, bypassing auth policies

run npm apidocs

216b3ac

address try/catch comment

fb5a3de

address await and reject grouping comment

fd4ffb5

stephenarosaj added 9 commits October 3, 2025 11:08

revert OperationRef.execute() API to executeOperation API

12f1258

revert OperationRef.execute() API to executeOperation API

60649e4

revert tests to use DataConnect.executeOperation() API instead of Ope…

918c4a0

…rationRef.execute() API

revert package version

4dad488

merge master into rosa/impersonate

786c75f

update executeOperation API to return executeOperationResponse

89e691a

update comments

5721657

add invalidateAdminArgs to handle variadic JS executeOperation arguments

fd61f1a

npm run apidocs for validateAdminArgs

104a1c5

maneesht reviewed Oct 14, 2025

View reviewed changes

maneesht requested changes Oct 14, 2025

View reviewed changes

stephenarosaj added 8 commits October 14, 2025 15:28

update validateAdminArgs documentation

652c059

address validateAdminArgs and some test comments

79b55eb

update validate-admin-args and add tests, address existing test comme…

97f75f3

…nts, revert package changes

update tests

f7d2a5b

update tests

e95a035

address mutation test comments

4e5fbcb

address prod url comments

b83b6da

finally fixed unit tests

39cfb9d

maneesht reviewed Oct 15, 2025

View reviewed changes

REALLY fixed unit tests

5d4cbab

maneesht reviewed Oct 15, 2025

View reviewed changes

maneesht approved these changes Oct 15, 2025

View reviewed changes

maneesht reviewed Oct 15, 2025

View reviewed changes

lahirumaramba reviewed Oct 16, 2025

View reviewed changes

lahirumaramba requested changes Oct 16, 2025

View reviewed changes

lahirumaramba reviewed Oct 16, 2025

View reviewed changes

	expect(inputVars).to.deep.equal(inputVars);
	expect(inputVars).to.deep.equal(variables);

feat(dc): Add executeQuery and executeMutation APIs to Data Connect #2979

Are you sure you want to change the base?

feat(dc): Add executeQuery and executeMutation APIs to Data Connect #2979

Uh oh!

Conversation

stephenarosaj commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Changes

Testing

Uh oh!

stephenarosaj commented Sep 17, 2025

Note:

Uh oh!

stephenarosaj commented Sep 18, 2025

Uh oh!

stephenarosaj commented Sep 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stephenarosaj commented Sep 17, 2025 •

edited

Loading